package com.roamer.validator;


import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 自定义枚举校验注解
 * <p>
 * 用于验证属性值是否在枚举值范围内
 * {@link Constraint }定义自定义校验注解,{@code validatedBy}属性用于指定验证类
 * </p>
 *
 * @author roamer
 * @version V1.0
 * @date 2019/07/13 16:45
 */
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumValue.List.class)
@Constraint(validatedBy = EnumValueValidator.class)
public @interface EnumValue {

    String message() default "无效枚举值";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    /**
     * 指定的枚举类
     *
     * @return {@code Class<? extends Enum<?>>}
     */
    Class<? extends Enum<?>> enumClass();

    /**
     * 用于校验的方法
     * <p>
     * 必须为static修饰，返回值为boolean类型
     *
     * @return {@code String} {@link EnumValue#enumClass}中的函数名称
     */
    String enumMethod();

    /**
     * Bean的一个属性上可以添加多套规则
     */
    @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        EnumValue[] value();
    }

}
